<?php

namespace PHPExcel\Shared\OLE\PPS;

/* vim: set expandtab tabstop=4 shiftwidth=4: */
// +----------------------------------------------------------------------+
// | PHP Version 4 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1997-2002 The PHP Group |
// +----------------------------------------------------------------------+
// | This source file is subject to version 2.02 of the PHP license, |
// | that is bundled with this package in the file LICENSE, and is |
// | available at through the world-wide-web at |
// | http://www.php.net/license/2_02.txt. |
// | If you did not receive a copy of the PHP license and are unable to |
// | obtain it through the world-wide-web, please send a note to |
// | license@php.net so we can mail you a copy immediately. |
// +----------------------------------------------------------------------+
// | Author: Xavier Noguer <xnoguer@php.net> |
// | Based on OLE::Storage_Lite by Kawai, Takanori |
// +----------------------------------------------------------------------+
//
// $Id: File.php,v 1.11 2007/02/13 21:00:42 schmidt Exp $


/**
 * Class for creating File PPS's for OLE containers
 *
 * @author Xavier Noguer <xnoguer@php.net>
 * @category PHPExcel
 * @package PHPExcel_Shared_OLE
 *         
 */
class File extends \PHPExcel\Shared\OLE\PPS {
    /**
     * The constructor
     *
     * @access public
     * @param string $name
     *            The name of the file (in Unicode)
     * @see OLE::ascToUcs()
     */
    public function __construct($name) {
        parent::__construct(null, $name, \PHPExcel\Shared\OLE::OLE_PPS_TYPE_FILE, null, null, null, null, null, '', array());
    }
    
    /**
     * Initialization method.
     * Has to be called right after OLE_PPS_File().
     *
     * @access public
     * @return mixed true on success
     */
    public function init() {
        return true;
    }
    
    /**
     * Append data to PPS
     *
     * @access public
     * @param string $data
     *            The data to append
     */
    public function append($data) {
        $this->_data .= $data;
    }
    
    /**
     * Returns a stream for reading this file using fread() etc.
     * 
     * @return resource a read-only stream
     */
    public function getStream() {
        $this->ole->getStream($this);
    }
}
